home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / ForCLI / HexD2.lha / HexD.Man < prev   
Text File  |  1993-02-21  |  6KB  |  171 lines
  1.  
  2.     HexD V2.0                   USER COMMANDS                   HexD V2.0
  3.  
  4.  
  5.     NAME
  6.     HexD - Print a file, using "hex" format.
  7.  
  8.  
  9.     SYNOPSIS
  10.     HexD FILES/M,TO/K,WIDTH/K/N,ALL/S,APPEND/S,HEX/S,ASCII/S,
  11.          NOOFFSET/S,HEADER/S,CURSOR/S,PAGE/S
  12.  
  13.  
  14.     DESCRIPTION
  15.     HexD takes each filename, and tries to write the file in hex
  16.     format on standard output (or a file). If no filename was given,
  17.     HexD will read from standard input. By default, this means that
  18.     each line looks like this:
  19.  
  20.     <offset:> <hex representation> <ascii representation>
  21.  
  22.     Offset is simply the offset of the first byte on each line.
  23.  
  24.     Hex representation is the value of the bytes (in hexadecimal
  25.     format), ordered in groups of four bytes (one longword), with
  26.     each group separated by a space.
  27.  
  28.     Ascii representation is the ascii (character) form of the byte,
  29.     or "·" if no valid char exists.
  30.  
  31.     An example:  The first three lines of this file looks like this
  32.     (using default settings, except for width, which is 60):
  33.  
  34.     000000: 0a202020 20486578 44202020 202020 '·    HexD      '
  35.     00000f: 20202020 20202020 20202020 202020 '               '
  36.     00001e: 20202055 53455220 434f4d4d 414e44 '   USER COMMAND'
  37.  
  38.     Pressing ctrl-c will break the program, and pressing ctrl-d will
  39.     cause a "file break", i.e. HexD will stop processing the current
  40.     file, and will move to the next one (if any).
  41.  
  42.     HexD is pure, and may be made resident.
  43.  
  44.     Thanks to Justin V. McCormick for his GetWinBounds() routine,
  45.     found in LS v3.1. A slightly adopted version is used in HexD.
  46.  
  47.     INPUTS
  48.     FILES/M
  49.         The files to print. Any number of files may be specified
  50.         (the shell, or the amount of free memory may limit this),
  51.         including zero, in which case standard input will be read
  52.         (very useful for pipes etc). These filenames may contain
  53.         standard AmigaDOS patterns.
  54.  
  55.     TO/K
  56.         Specifies a file to which the output will be printed. If not
  57.         specified, print everything to standard output. You should
  58.         use this option rather than using the ">" shell construct,
  59.         since by using this parameter, any errors and breaks will be
  60.         printed in the shell window rather than in the output file.
  61.  
  62.     WIDTH/K/N
  63.         The number of chars the display should use as a max (the
  64.         acutal amount used may be somewhat smaller than this). This
  65.         number should be less than 512. The minimal width depends on
  66.         the display format currently in use, and it will ensure that
  67.         at least one byte will fit within the width limit. If not
  68.         specified, and the output is in a "CON: window", the width
  69.         of the window and font will set the width. The size of the
  70.         window will be re-checked after each file, and after each
  71.         page prompt (if paging was enabled). If the window gets too
  72.         narrow, HexD will exit with a suitable message. If output
  73.         isn't a CON: window (and this parameter wasn't specified),
  74.         75 chars will be used.
  75.  
  76.     ALL/S
  77.         Makes HexD enter all direcotries it finds during the search
  78.         for matching files. If not specified, directories are
  79.         ignored.
  80.  
  81.     APPEND/S
  82.         Normally, HexD will overwrite any TO file if it should exist.
  83.         By specifying this option, HexD will instead append to the
  84.         file if it should exist. If no TO file was specified, this
  85.         option have no effect.
  86.  
  87.     HEX/S
  88.         Make the output only contain the hex representation. If ASCII
  89.         is used at the same time, the normal output format will be
  90.         used.
  91.  
  92.     ASCII/S
  93.         Make the output only contain the ascii representation. If HEX
  94.         is used at the same time, the normal output format will be
  95.         used.
  96.  
  97.     NOOFFSET/S
  98.         Do not print the offset at the start of each line.
  99.  
  100.     HEADER/S
  101.         Print the name of each file before it is processed. If no
  102.         filename was given (i.e. standard input is read) this switch
  103.         will have no effect.
  104.  
  105.     CURSOR/S
  106.         Normally, HexD will "hide" the cursor during printing, in
  107.         order to increase the output speed (this will only be done if
  108.         the output is in a "CON: window"). This switch will disable
  109.         that (i.e. cursor is not "hidden").
  110.  
  111.     PAGE/S
  112.         Make HexD "page" the output, i.e. show a prompt and wait for
  113.         a key-press after each screenful of output. This will only
  114.         happen if the output is in a CON: window. There are a few
  115.         keys which will do something special:
  116.         Return    : Display next line.
  117.         S         : No more page prompts for this file.
  118.         =         : No more page prompts for this run of HexD.
  119.         Backspace : Show previous page of this file.
  120.         All other keys will show the next page.
  121.  
  122.  
  123.     RESULTS
  124.     The file(s) printed in hex format.
  125.  
  126.  
  127.     NOTES
  128.     All error messages will be printed to standard output.
  129.  
  130.     An interesting thing about this program is that it is noticably
  131.     faster than most other similar programs, such as C='s "Type"
  132.     (V37.2), Xd (unknown version, part of the SKSh package version
  133.     1.4 or something like that) etc. As a matter of fact, it is the
  134.     fastest (CLI-based) hexdumper I have. It is also the most
  135.     flexible. :)
  136.  
  137.     I made a test, by dumping an executable to a file in RAM:, and
  138.     HexD was ~2.5 times faster than Type. The file was almost 70 Kb
  139.     large, and it took Hexd ~35 secs on my unaccelerated Amiga 500
  140.     (both times the program in question was cached, so it was
  141.     basically ram to ram "conversion").
  142.  
  143.     The source is really a bit messy. I ought to clean it up some
  144.     day.. :)
  145.  
  146.     COPYRIGHT
  147.     This program is purely public domain. But leave my name in it,
  148.     will you? I would appriciate it.. :)
  149.  
  150.  
  151.     AUTHOR
  152.     Magnus Holmgren. (V1.0-2.0)
  153.  
  154.  
  155.     AUTHOR CONTACT
  156.     Magnus Holmgren:
  157.         You can reach me via internet, on these addresses:
  158.  
  159.         cmh@augs.se                or
  160.         cmh@lysator.liu.se            or
  161.         magnus_holmgren@augs.liu.se        or
  162.         d91magho@und.ida.liu.se
  163.  
  164.         Echo-mail (fidonet) should work too. Send it to 2:204/404.6
  165.         Otherwise snailmail is recommended to this address:
  166.  
  167.         Magnus Holmgren
  168.         Rydsvägen 254  A:14
  169.         S-582 51  Linköping
  170.         SWEDEN
  171.